Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Wi-Fi firmware partition support for Pico 2 W #1969

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from

Conversation

will-v-pi
Copy link
Contributor

This adds the ability to store and load the Wi-Fi firmware for Pico 2 W in a partition. It can be enabled by adding pico_use_partition_firmware(<exe_name>) to your CMakeLists.txt, which will embed a compatible partition table in the binary, and output lots of firmware UF2s to use (all called <exe_name>_firmware_..._.uf2, eg ..._firmware_w for Wi-Fi only, ..._firmware_wb for Wi-Fi and Bluetooth, ..._firmware_w_tbyb for TBYB). You can also create your own partition table and use that.

A Wi-Fi firmware partition is detected as having the ID 0x123456789abcdef0, and the UF2 family_is for Wi-Fi firmware blobs is 0x12345678 - these should probably both be changed to something else before merging? The default firmware partition starts at 3500K into the flash - should this be changed to depend on PICO_FLASH_SIZE_BYTES? The default firmware partition is also duplicated with A/B partitions in the same location in flash - this is required to ensure a signature check is performed before loading the Wi-Fi firmware, as there's no way to call the bootrom to check the signature of a single partition (unless chaining into it), you can only call pick_ab_partition.

The Wi-Fi firmware blob is marked in it's image_def as an RP2350 Risc-V executable, and the partition is marked as ignored_during_riscv_boot - this ensures that it can work with TBYB (as TBYB only works for executable image_defs), and that signature checks are performed before loading the firmware when Secure Boot is enabled (because signature checks are performed for all executable image_defs in a partition that is not marked ignored_during_arm_boot). This is slightly clunky, but seems to work robustly.

Supercedes #1850, as it now includes that function in this PR, and shows a use for it.

@lurch
Copy link
Contributor

lurch commented Oct 3, 2024

pinging @peterharperuk as he did a lot of the Wifi-related stuff for Pico 1.

@will-v-pi will-v-pi marked this pull request as ready for review October 17, 2024 09:01
@will-v-pi will-v-pi added this to the 2.0.1 milestone Oct 30, 2024
@peterharperuk
Copy link
Contributor

Works nicely. I think we need to fix the Pico W (rp2040) build errors in src/rp2_common/pico_cyw43_driver/cyw43_driver.c
It would be nice if it gave an error if you're a numpty like me and put pico_use_partition_firmware after pico_add_extra_outputs, but that could be improved later?

@will-v-pi
Copy link
Contributor Author

It would be nice if it gave an error if you're a numpty like me and put pico_use_partition_firmware after pico_add_extra_outputs, but that could be improved later?

Have added in separate PR #2054

@will-v-pi
Copy link
Contributor Author

I think we need to fix the Pico W (rp2040) build errors in src/rp2_common/pico_cyw43_driver/cyw43_driver.c

I've added a check that it's not RP2040 in the CMake function, so it'll throw a fatal error at that point if you try to build a binary with pico_use_partition_firmware for RP2040

@armandomontanez
Copy link
Contributor

armandomontanez commented Nov 19, 2024

If the Bazel checks are getting in your way, you can add the two new files to a filegroup (which will silence the error) and file an issue+leave a TODO to support this in Bazel and assign it to me.

Copy link
Contributor

@peterharperuk peterharperuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested this and it seems good.

peterharperuk
peterharperuk previously approved these changes Nov 19, 2024
@will-v-pi
Copy link
Contributor Author

If the Bazel checks are getting in your way, you can add the two new files to a filegroup (which will silence the error) and file an issue+leave a TODO to support this in Bazel and assign it to me.

Thanks, have done - I couldn't actually assign the issue to you, but have tagged you in it

@lurch
Copy link
Contributor

lurch commented Nov 19, 2024

A Wi-Fi firmware partition is detected as having the ID 0x123456789abcdef0, and the UF2 family_is for Wi-Fi firmware blobs is 0x12345678 - these should probably both be changed to something else before merging?

Is that still going to be happening? I guess choosing randomly-generated IDs is much less likely to produce an accidental collision than a "nice" ID like 0x123456789abcdef0 ? And should those IDs be added to a header-file, to allow other UF2s to make use of this Wi-Fi firmware partition?

@will-v-pi
Copy link
Contributor Author

A Wi-Fi firmware partition is detected as having the ID 0x123456789abcdef0, and the UF2 family_is for Wi-Fi firmware blobs is 0x12345678 - these should probably both be changed to something else before merging?

Is that still going to be happening? I guess choosing randomly-generated IDs is much less likely to produce an accidental collision than a "nice" ID like 0x123456789abcdef0 ? And should those IDs be added to a header-file, to allow other UF2s to make use of this Wi-Fi firmware partition?

Yes - I was looking for ideas. We could go with 0x776966696669726d (hex for wififirm) for the partition ID, and just use the data family_id we already have?

@lurch
Copy link
Contributor

lurch commented Nov 20, 2024

Yes - I was looking for ideas. We could go with 0x776966696669726d (hex for wififirm) for the partition ID, and just use the data family_id we already have?

I've got no opinions on this so it's probably something that you and @peterharperuk ought to decide. Would MicroPython be able to use the same Wifi firmware partition as C-SDK code? (or is that another one of my stupidly naive questions? 😆 )

@will-v-pi
Copy link
Contributor Author

I've now got it working for Risc-V by storing copies of the firmware ELFs in the SDK, and then copying those into the build when necessary. It also needs increased bootrom stack size. This is tested and working fine.

However, I'm not sure if this is actually a solution that we want to put in the 2.1.0 SDK release, so it might be best if we don't merge this for 2.1.0 and I can investigate further to fix the Risc-V firmware build?

@will-v-pi will-v-pi modified the milestones: 2.1.0, 2.2.0 Nov 22, 2024
will-v-pi added a commit to will-v-pi/pico-sdk that referenced this pull request Jan 14, 2025
Add the rom_pick_ab_update_partition function from raspberrypi#1969
@richard9999999999
Copy link

I see that default firmware partition ID is defined as follows:
#define CYW43_FIRMWARE_PARTITION_ID 0x776966696669726d // wififirm
SDK uses this value as default to find the partition

..Also in pt.json, this long value is used
"id": "0x776966696669726d",

However when I check by picotool, I see following number set as partition ID:

 partition 1 (A):       0036b000->003a7000 S(rw) NSBOOT(rw) NS(rw), id=000000006669726d, "Wi-Fi Firmware", uf2 { data },
                        arm_boot 1, riscv_boot 0

So upper 32 bits are zeros..
And I need to set this truncated value to CYW43_FIRMWARE_PARTITION_ID to get it working.

Did I miss something?

@richard9999999999
Copy link

richard9999999999 commented Feb 21, 2025

One more note:

function(pico_use_wifi_firmware_partition TARGET)
        if (PICO_PLATFORM STREQUAL "rp2040")
                message(FATAL_ERROR "RP2040 does not support storing wi-fi firmware in partitions")
        endif()
        target_compile_definitions(${TARGET} PRIVATE CYW43_USE_FIRMWARE_PARTITION=1)
        pico_embed_pt_in_binary(${TARGET} ${PICO_CYW43_DRIVER_CURRENT_PATH}/wifi_pt.json)

seems like that partitioning of binary is always done according wifi_pt.json file. In many cases user prefers to have his own partitioning (when e.g. custom bootloader is used). Could'n this be done via preprocessor macro define e.g. something like "CYW43_EMBED_FIRMWARE_PARTITION=0"?

will-v-pi added 11 commits April 7, 2025 16:54
Enabled using the pico_use_partition_firmware(exe_name) cmake function
RP2040 does not support partitions, so throw fatal_error at the CMake stage
… family

Adds CYW43_WIFI_FW_PARTITION_ID define to override the partition ID
Add copyright headers

Put ptinfo buffer on the stack, and break when partition is found

Improve function description
… CYW43_WIFI_FW_PARTITION_ID->CYW43_FIRMWARE_PARTITION_ID
The Risc-V compiler doesn't link the firmware blobs as expected, so use Arm ELFs instead
@will-v-pi
Copy link
Contributor Author

Rebased onto develop, which contains the rom_pick_ab_update_partition function

@will-v-pi
Copy link
Contributor Author

However when I check by picotool, I see following number set as partition ID:

This looks like a bug in your build of picotool - for me it shows the correct full ID, and the ID in the actual partition table in flash should also be correct. If you're still seeing this with the latest picotool develop branch, could you raise an issue against that repo with details of how you're building picotool?

In many cases user prefers to have his own partitioning (when e.g. custom bootloader is used)

I will push a commit to only set the partition table if it has not already been defined, and if the user defines it afterwards then that will override this definition

@richard9999999999
Copy link

richard9999999999 commented Apr 8, 2025

This looks like a bug in your build of picotool

The picotool used to embed the pt into my binary is loaded and built "automatically" into project's "build" folder. I will wait till this your change will be committed into the dev branch and then I will check again..

@richard9999999999
Copy link

richard9999999999 commented Apr 8, 2025

The
"picotool version"
shows
"picotool v2.1.2-develop (Windows, GNU-8.1.0, Release)"

@richard9999999999
Copy link

richard9999999999 commented Apr 9, 2025

I will push a commit to only set the partition table if it has not already been defined, and if the user defines it afterwards then that will override this definition
This solution does not fit to my case: I use encrypted bootloader and all partitioning (including wifi firmware partition) is defined in the bootloader binary (so in the different binary). Thus in this case we cannot decide wifi partition has been included or not using yours:
get_target_property(picotool_embed_pt ${TARGET} PICOTOOL_EMBED_PT)

@will-v-pi
Copy link
Contributor Author

That use case will work fine - the embedded partition table in these binaries will be ignored when they’re booted from partitions by the bootloader (as opposed to when they’re booted from slots, see 5.1.12-15 in the datasheet for more details)

@richard9999999999
Copy link

OK so I will check that. Thanks much!

@richard9999999999
Copy link

One more note (possibly bug), which I found while debugging my problem with truncated partition ID:

file cyw43_driver.c

    } else {
        CYW43_DEBUG("No partition table, so cannot get firmware from partition - get_partition_table_info returned %d\n", ret);
        return false;
    }

above else is for "no partition table found" case. However the error case when we have some partitions but not with correct ID is not handled and it continues in initialization.
I mean missing else for:
if (picked_p >= 0) {

@richard9999999999
Copy link

That use case will work fine - the embedded partition table in these binaries will be ignored when they’re booted from partitions by the bootloader (as opposed to when they’re booted from slots, see 5.1.12-15 in the datasheet for more details)

Unfortunately in the encrypted bootloader sample like scenario (like my project) the wifi partition in the executable binary seems causes malfunction. So I have to exclude the wifi partition from the executable (by hack of your branch) and add it into the bootloader only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants